home *** CD-ROM | disk | FTP | other *** search
/ OpenGL Superbible (2nd Edition) / OpenGL SuperBible e2.iso / tools / GLUT-3.7 / README.MAN < prev    next >
Encoding:
Text File  |  1998-08-12  |  3.1 KB  |  81 lines
  1.  
  2. Since GLUT 3.2, GLUT includes complete API man pages.  These man pages
  3. use the standard Unix man macros, so to be useful, they must be
  4. formatted with nroff (or psroff or groff or ditroff or troff, depending
  5. on what your system provides).  You can find the raw nroff source for
  6. the GLUT API man pages in the "man/glut subdirectory".
  7.  
  8. Below are instructions that should help the SGI and non-SGI GLUT user
  9. get these man pages installed.
  10.  
  11. SILICON GRAPHICS USERS
  12. -----------------------
  13. The easiest way to install the GLUT man pages on your Silicon Graphics
  14. system is to install the "glut_dev.man.glut" subsystem on your SGI
  15. workstation.  This subsystem contains pre-formatted man pages which
  16. are placed in the /usr/share/catman/p_man/cat3/GLUT subirectory.  Once
  17. installed, simply type "man glutInit" (or any other GLUT routine) to
  18. view the man pages.
  19.  
  20. You _can_ build the man pages from the supplied nroff source files,
  21. but this *requires* that you have the Documenter's WorkBench (dwb)
  22. images installed or have GNU groff available.  This is why I strongly
  23. recommend saving your time and simply installing the man pages from
  24. the pre-built SGI images that accompany this GLUT source code
  25. distribution.
  26.  
  27. If you must build the man pages yourself...  As supplied, the SGI
  28. Makefiles will not descend into nor build the Makefiles.  You'll need
  29. to do the following by hand:
  30.  
  31.   cd man/glut
  32.   make
  33.  
  34. Then, install the man pages into /usr/share/catman/p_man/cat3/GLUT by
  35. executing (assuming your have write permission):
  36.  
  37.   make install
  38.  
  39. Again, I strongly recommend simply installing the pre-built man pages
  40. from the "glut_dev" images.
  41.  
  42. NON-SILIGON GRAPHICS USERS
  43. ---------------------------
  44. If you are not using a Silicon Graphics system, you *must* use
  45. Documeter's WorkBench or GNU groff to format the man pages.
  46.  
  47. Unfortunately, man pages are formatted and installed in different ways
  48. depending on your system.  If you don't have a Silicon Graphics
  49. system, you are going to need to use imake (the X11 Makefile
  50. configuration system) to build a Makefile that should format and
  51. install the man pages appropriately.  Assuming everything is
  52. configured appropriately, things should just work.  If not, you'll
  53. need to figure out what went wrong (I won't be able to help you).
  54.  
  55. To format and install (this is a single step unfortunately), run the
  56. following commands in GLUT's toplevel directory:
  57.  
  58.   make SUBDIRS=man Makefiles
  59.   make SUBDIRS=man
  60.   cd man/glut
  61.   make install.man
  62.  
  63. The installation assumes that you have permission to install the man
  64. pages in the appropriate destination.  If you don't want them
  65. installed in the standard location or don't have permission, try to
  66. set your DESTDIR environment variable to some directory where you want
  67. the man pages installed.  For example:
  68.  
  69.   setenv DESTDIR ~/fakeroot
  70.  
  71. TUBING AND EXTRUSION LIBRARY (GLE) MAN PAGES
  72. ---------------------------------------------
  73. GLUT 3.6 includes man pages (derived from Linas Vepstas's HTML
  74. documentation for GLE).  The man page source is found in the "man/gle"
  75. directory.
  76.  
  77. To build the GLE man pages, follow the instuctions above, but
  78. substitute "gle" for "glut" in the commands above.
  79.  
  80. - Mark Kilgard
  81.